7.5 删除外部用户角色

基本信息

Path: /api/v2/externalUserRole/delete

Method: POST

接口描述:

  1. 删除外部用户角色

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 必须  

Body

  1. 部分参数,如关联对象ID,需要通过在控制台手动获取,以Chrome浏览器为例,获取方式为F12打开“开发者工具”,在Network中找到对应对象的查询接口手动获取该对象的ID
  2. 用户目录ID,userDirectoryId获取方式,用“开发者工具”过滤请求 userDirectory/queryAll,打开控制台“业务管理”->“用户与角色”(原“用户管理”)页面,查看响应体数据获取对应用户目录的ID,也可以通过用户目录查询接口获取ID
名称 类型 是否必须 默认值 备注 其他信息
idList string[] 与nameList二选一 外部角色ID列表 idList与nameList只传一个即可,都传时以idList为准
nameList string[] 与idList二选一 外部角色名列表 >=2.2.10 SP3开始支持(2.2.12除外)
idList与nameList只传一个即可,都传时以idList为准
userDirectoryId string 与userDirectoryName二选一 外部用户目录ID userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准
userDirectoryName string 与userDirectoryId二选一 外部用户目录名字 >=2.2.10 SP3开始支持(2.2.12除外)
userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准

请求示例

{
    "userDirectoryName": "LDAP用户目录",
    "nameList": ["zhangsan"]
}

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 错误码,非0表示错误,具体含义请参考错误码定义
data object 必须 返回内容
msg string 必须 描述信息  

返回示例

{
    "code": 0,
    "data": {},
    "msg": "请求成功",
    "traceId": "0321d1efe3801000"
}

错误信息

错误提示 错误码
参数检查出错 10000001
服务器内部错误 10000000
角色不存在 77200001
用户目录不存在 77200004
数据不存在或已经被删除 77200001
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-09-05 14:20

results matching ""

    No results matching ""